home *** CD-ROM | disk | FTP | other *** search
/ Libris Britannia 4 / science library(b).zip / science library(b) / SCIENTIF / H558.ZIP / QDG206.ZIP / QDIGIT.DOC next >
Text File  |  1994-02-07  |  13KB  |  262 lines
  1.                                   QDIGIT
  2.  
  3.                Copyright (C) 1992, 1993, 1994  P.C. Jahans
  4.                            All rights reserved.
  5.  
  6.  
  7.                                  OVERVIEW
  8.  
  9. QDigit is an easy-to-use digitizing program which works with many brands
  10. of digitizer tablets at speeds of up to 9600 baud in either binary or
  11. ASCII format.  Point and linear data, including contours, outcrops, well
  12. locations, etc., can be digitized from any map.  Output is sent to text
  13. files in the form of 2D coordinates and other associated data supplied by
  14. the user.  Options, calibration, and communication settings can be saved
  15. to and retrieved from configuration files.  Especially suited to
  16. geological applications, QDigit can also be used for any kind of 2D
  17. digitizing: topographic maps, cross-sections, drawings, graphs, etc.  An
  18. affine transform is used to produce accurate results even from distorted
  19. maps (those which are no longer rectangular but more like irregular
  20. quadrilaterals).  Other features include context-sensitive online help,
  21. full mouse support, file viewing and printing.
  22.  
  23.  
  24.                               DOCUMENTATION
  25.  
  26. Except for the online help, this is it.  The context-sensitive online
  27. help is fairly extensive and covers everything you need to know to
  28. configure and operate QDigit.  Once the program has been configured to
  29. your digitizer, you can use it right away.  To get familiar with the
  30. program's features, highlight the menu items in turn and press <F1> to
  31. bring up the help window describing each item.  Most people don't want to
  32. read a manual anyway.  If you want to skip most of this stuff, just scan
  33. the configuration section (and of course the disclaimer) and crank up the
  34. program.  The interface is pretty standard.
  35.  
  36.  
  37.                                INSTALLATION
  38.  
  39. Place QDIGIT.EXE and QDIGIT.HLP in a directory specified in the PATH
  40. command or in a working directory from which you will be digitizing your
  41. maps.  A default configuration file will automatically be saved to and
  42. retrieved from the same directory that the program resides in.  You may
  43. save and retrieve configurations using any other directory and file name
  44. specified with the Setup|Save Setup and Setup|Load Setup menu commands.
  45. Also, typing QDIGIT /c <filename> on the DOS command line causes QDigit
  46. to read in the specified configuration file upon startup.  Installation
  47. is not complete until QDigit has been configured to your digitizer.  The
  48. following section explains how to do it; a brief version is available
  49. online.
  50.  
  51.  
  52.                        CONFIGURING TO THE DIGITIZER
  53.  
  54. Before using QDigit to digitize a map, the program must be configured to
  55. your digitizing tablet.  This is a two step process: 1) communications
  56. settings, and 2) setting the digitizer data format.  You must refer to
  57. the documentation that came with your digitizer to determine what
  58. parameters are required for these two steps.  This is the only critical
  59. part to the installation process.
  60.  
  61. Step 1.  Start QDigit.  Your digitizer must be connected to one of the
  62. serial ports available on your computer.  Note that most computers do not
  63. have ports 3 or 4 built in; these are usually added later by purchasing a
  64. separate comm card.  Only standard IRQ configurations are currently
  65. supported.  Select Setup|Advanced Setup|Comm Settings from QDigit's menu
  66. and choose the communication settings appropriate for your digitizer.
  67. Most newer tablets will operate at 9600 baud, 8 data bits, 1 stop bit, no
  68. parity.  Another common setting is 9600 baud, 7 data bits, 2 stop bits,
  69. even parity.
  70.  
  71. Step 2.  If your digitizer is set to binary mode output, select
  72. Setup|Advanced Setup|Data Format from QDigit's menu and choose the
  73. appropriate binary format.  Low resolution and high resolution binary are
  74. standard formats which can be output by most tablets such as Calcomp
  75. (TM).  Others, notably Summagraphics (TM), require either the MM or UIOF
  76. binary format.  Note that low resolution binary generally goes with a
  77. comm setting of 7 data bits, even or odd parity, and that high resolution
  78. usually coincides with 8 data bits, no parity.
  79.  
  80. If your digitizer is set to ASCII mode output, select Setup|Advanced
  81. Setup|Data Format|ASCII from QDigit's menu.  You must determine from your
  82. digitizer's documentation and/or any supplied utility programs the
  83. positions and lengths (number of characters) for the X and Y coordinates
  84. and the button character.  An example ASCII format is shown:
  85.  
  86.    Output from digitizer:     SBXXXXXXYYYYYYRL
  87.    where:
  88.       S     status flag
  89.       B     button character
  90.       X     digit for the X coordinate
  91.       Y     digit for the Y coordinate
  92.       R     carriage return
  93.       L     line feed
  94.  
  95.    In this example, your ASCII settings should be:
  96.                          Button Position -- 2
  97.           X Coordinate Starting Position -- 3, Length -- 6
  98.           Y Coordinate Starting Position -- 9, Length -- 6
  99.  
  100. If there is more than one button character, use the first one, last one,
  101. or the one corresponding to the button you wish to be sensed by the
  102. program.  ASCII formats run at slower sampling rates and are more
  103. difficult to configure.  It is generally more efficient and easier to use
  104. a binary format.
  105.  
  106.  
  107.                                USING QDIGIT
  108.  
  109. Once QDigit has been configured to your digitizer it is ready to use.  It
  110. is a good idea to save the configuration at this point with the
  111. Setup|Save Setup menu selection, and even to copy the configuration file
  112. to a safe place.  This avoids having to reconfigure to the digitizing
  113. tablet in case the working configuration file is changed or deleted.
  114.  
  115. To digitize a map (or drawing, etc.) QDigit should be calibrated to the
  116. coordinates used by the map.  This will create output data in your
  117. working coordinates instead of digitizer coordinates and, more
  118. importantly, compensates for the likelihood that your map is not placed
  119. exactly square to the axes of the digitizing tablet.  Tape the map down
  120. onto the tablet surface, then select Setup|Calibrate|Calibrate Map from
  121. the menu.  Choose X-Y coordinates or Lon-Lat coordinates, then follow the
  122. instructions on the screen.  QDigit will ask for four known calibration
  123. points that you must digitize on your map and enter into a dialog box on
  124. the screen.  Points are digitized by pressing the main button of the
  125. digitizer's cursor (or puck or mouse) -- a beep will be heard when the
  126. point coordinate is received.  Do this as carefully as possible -- the
  127. accuracy of all subsequent digitizing depends on how well you do this
  128. step.  Once the four calibration points are obtained, you are ready to
  129. digitize your map.
  130.  
  131. The menu items under Digitize indicate the type of digitizing you can do.
  132. Points and lines are generic digitizing functions useful for any map,
  133. drawing or graph, while contours, wells and outcrops are especially
  134. suited to geologic and topographic mapping.  Note that the Digitize|Well
  135. Locations function can be used for any kind of point digitizing where
  136. information must be saved with every 2D coordinate.  If outcrops are to
  137. be digitized, QDigit will request that you digitize the south and north
  138. ends of any line parallel to north.  This is required to obtain correct
  139. azimuths for outcrops.  Alternatively, you may use the Setup|Calibrate|
  140. Calibrate North menu selection.
  141.  
  142. When any menu item under Digitize is selected, a file selector dialog box
  143. appears, in which you should enter an output file name (or click on an
  144. existing one to be appended to) to which data will be sent.  The numeric
  145. format of the 2D coordinates can be specified, if desired, using the
  146. Setup|Set Precision menu selection.  Digitizing commences when you press
  147. the digitizer's main cursor button or press the digitizing pen to the
  148. tablet.  When doing lines or contours do not hold the button down while
  149. the cursor is stationary as this will cause a stream of identical
  150. coordinates to be saved to the output file.  Output consists of 2D
  151. coordinates (and possibly other related data) saved one per line to the
  152. output file.  If digitizing lines or contours, pressing the <Enter> or
  153. <Return> key during a pause in digitizing will cause the word 'ENDLINE'
  154. to be saved to the file.  This is used as a marker for the end of a line
  155. so that more than one line may be digitized and saved in the same file.
  156.  
  157. Digitizing can be terminated at any time by pressing <F3> or <Esc>; data
  158. is always saved to the file as digitizing proceeds.  Data is always
  159. appended to output files; existing data is never erased by QDigit.
  160.  
  161. Upon exiting the program (using File|Exit or <Alt-X>) the current
  162. configuration, calibration and other items are automatically saved.  You
  163. may stop during a long night of digitizing, go for a coffee and come back
  164. later to pick up exactly where you left off as long as you didn't remove
  165. you map from the digitizing tablet.  Removing the map, of course, means
  166. having to recalibrate it.
  167.  
  168. Operational note: If the digitizing tablet is turned off or is not
  169. connected, user interaction with the menu system may be slowed down while
  170. the coordinate display is activated.  Toggling the coordinate display off
  171. with <F9> eliminates the effect.
  172.  
  173. Digitizing hint: cover the map to be digitized with wax paper, onion
  174. skin, cellophane or similar material.  After digitizing each line or
  175. point, mark the covering sheet with a felt pen or highlighter to keep
  176. track of what has been just been digitized.  A future update of QDigit
  177. will provide a graphics screen showing lines as they are digitized so
  178. that this step will not be necessary.  But hey, this version is free!
  179.  
  180.  
  181.                       DISTRIBUTION AND SHAREWARE FEE
  182.  
  183. This program may be freely distributed and you are encouraged to do so.
  184. Individuals, students and educational institutions may license one copy
  185. free of charge (ie. the shareware payment is voluntary).  If more than
  186. one copy is required, or if the program is used in a professional or
  187. commercial environment, a fee payment is required after a 30-day trial
  188. period as follows:
  189.  
  190.    Individuals, educational institutions:
  191.                      Free     for the first copy
  192.                      $25      for extra copies
  193.  
  194.    Industry:         $50      for the first copy
  195.                      $25      for additional copies
  196.  
  197. Payment may be made in US or Canadian dollars in the form of a cheque or
  198. money order addressed to the author at the address below.  Please do not
  199. send cash.
  200.  
  201. Payment of the fee entitles the user to a registered copy and one free
  202. upgrade to the next release of QDigit which will feature HPGL graphics
  203. file output, redundant point elimination (line simplification), geo-
  204. physical and dipmeter log digitizing, and graphical line representation
  205. on-screen, OR a Windows version with the same new features when it is
  206. released later in 1994.
  207.  
  208. Anyone wishing to charge a fee for distributing copies of this program is
  209. authorized to do so provided:
  210.  
  211.    1. A nominal fee is charged to cover only the copying, postage and
  212.       other such distribution costs.
  213.  
  214.    2. The offering and sale of this program will be stopped at any time
  215.       the author so requests.
  216.  
  217.    3. Problems or complaints will be reported to the author for
  218.       resolution.
  219.  
  220.  
  221.                           DISCLAIMER OF WARRANTY
  222.  
  223. BECAUSE OF THE VARIOUS HARDWARE AND SOFTWARE ENVIRONMENTS INTO WHICH THIS
  224. PROGRAM MAY BE PUT, THIS PROGRAM IS PROVIDE "AS IS" WITHOUT WARRANTY OF
  225. ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
  226. IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  227. PURPOSE.  THE USER MUST ASSUME THE ENTIRE RISK OF USING THE PROGRAM.  IN
  228. NO EVENT WILL THE COPYRIGHT HOLDER BE LIABLE TO YOU FOR DAMAGES,
  229. INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
  230. ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM, INCLUDING BUT NOT
  231. LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES
  232. SUSTAINED BY YOU OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
  233. PROGRAMS.
  234.  
  235.  
  236.                                    BUGS
  237.  
  238. Should you find a bug in the program please report it, being as specific
  239. as possible, with all relevant details as to its occurrence.  As well,
  240. suggestions for improvements and new features are encouraged.  Please
  241. contact the author by e-mail or regular mail at the address below.
  242.  
  243.  
  244.                           CONTACTING THE AUTHOR
  245.  
  246. This program was written while the author was a graduate student at the
  247. University of Alberta.  The university itself is in no way associated
  248. with the program, nor should it be contacted for any information, advice,
  249. or complaints regarding it.  All statements and opinions contained in the
  250. program and its documentation are those of the author.  Please submit all
  251. correspondence to:
  252.  
  253.                              Peter C. Jahans
  254.                              Dept. of Geology
  255.                           University of Alberta
  256.                             Edmonton, Alberta
  257.                                   CANADA
  258.                                  T6G  2E3
  259.  
  260.                (internet: pcjahans@cepheus.ucs.ualberta.ca)
  261.  
  262.